/
IPortalAliasController.cs
52 lines (42 loc) · 2.34 KB
/
IPortalAliasController.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information
namespace DotNetNuke.Entities.Portals
{
using System.Collections.Generic;
/// <summary>
/// Do not implement. This interface is only implemented by the DotNetNuke core framework. Outside the framework it should used as a type and for unit test purposes only.
/// There is no guarantee that this interface will not change.
/// </summary>
public interface IPortalAliasController
{
/// <summary>Add a new Portal Alias.</summary>
/// <param name="portalAlias">The portal alias to add.</param>
/// <returns>The Id of the newly added portal alias.</returns>
int AddPortalAlias(PortalAliasInfo portalAlias);
/// <summary>Delete a Portal Alias.</summary>
/// <param name="portalAlias">The portal alias to remove.</param>
void DeletePortalAlias(PortalAliasInfo portalAlias);
/// <summary>Gets the portal alias info.</summary>
/// <param name="alias">The portal alias.</param>
/// <returns>Portal alias info.</returns>
PortalAliasInfo GetPortalAlias(string alias);
/// <summary>Gets the portal alias info.</summary>
/// <param name="alias">The portal alias.</param>
/// <param name="portalId">The Id of the portal in question.</param>
/// <returns>Portal alias info.</returns>
PortalAliasInfo GetPortalAlias(string alias, int portalId);
PortalAliasInfo GetPortalAliasByPortalAliasID(int portalAliasId);
/// <summary>Gets all the portal aliases defined.</summary>
/// <returns>A dictionary keyed by the HTTP Alias.</returns>
PortalAliasCollection GetPortalAliases();
/// <summary>Gets the portal alias by portal ID.</summary>
/// <param name="portalId">The portal ID.</param>
/// <returns>Portal alias collection.</returns>
IEnumerable<PortalAliasInfo> GetPortalAliasesByPortalId(int portalId);
PortalInfo GetPortalByPortalAliasID(int portalAliasId);
/// <summary>Updates the portal alias info.</summary>
/// <param name="portalAlias">The obj portal alias info.</param>
void UpdatePortalAlias(PortalAliasInfo portalAlias);
}
}